Skip to content

m2k: Restructure and add content#149

Merged
StancaPop merged 1 commit intomainfrom
m2k_review
Apr 27, 2026
Merged

m2k: Restructure and add content#149
StancaPop merged 1 commit intomainfrom
m2k_review

Conversation

@StancaPop
Copy link
Copy Markdown
Collaborator

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

@thorenscientific
Copy link
Copy Markdown
Collaborator

@StancaPop looks like the page build is failing. Once that's fixed I'd be happy to give this a read (as a heavy user of the "little blue wonder" m2k!)

Comment thread docs/tools/m2k/intro.rst
* Two input/output digital trigger signals for linking multiple instruments
(3.3V CMOS)
* Two-channel voltmeter (AC, DC, ±25V)
* Network analyzer – Bode, Nyquist, Nichols transfer diagrams of a circuit.
Copy link
Copy Markdown
Collaborator

@thorenscientific thorenscientific Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re: Vale error - Yes, Nyquist is conventionally capitalized.

Comment thread docs/tools/m2k/intro.rst
* External Power

* The equipment shall be powered by SELV with limited energy according to IEC 61010-1cl.9.4 or LPS/PS2 power source according to IEC 60950-1 / IEC 62368-1.
* An example external adapter (like `this one from Adafruit <https://www.adafruit.com/product/1995?gclid=CjwKEAjwjqO_BRDribyJpc_mzHgSJABdnsFWlRs2FrqbAVZt9erVQDN6LakvKxmYjiLjTHKe_7ZqVxoCPu3w_wcB>`__).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re: Vale error - yes, Adafruit is the name of a company.

@thorenscientific
Copy link
Copy Markdown
Collaborator

@StancaPop - comments / suggestions:

Not sure how the ordering of the left-hand menu is handled - through that level's index.rst? A more logical ordering would be:

  • ADALM2000
    • Introduction to the ADALM2000
    • For End Users (and its child pages)
    • For Developers
    • Using with MATLAB
    • Using with LabVIEW
    • Support

It looks like the labview.rst and intro.rst are at the same level as index.rst - does this make sense, or should these be placed in child folders?

I see there are still a few references to wiki pages - that's fine for now. But one to migrate as part of this PR would be the https://wiki.analog.com/university/tools/m2k/devs/hardware page, linked from "Schematics" in the "For Developers" page.

Another wiki reference would be the "quick start" https://wiki.analog.com/university/tools/m2k/users/quick_start - which is pretty minimal, and I'd argue so short it might just be better put inline in the For End Users page (snarky "Most people don't read instructions, and just want get things going: comment and all :) )

In the reference manual (reference_manual.rst) - the figures from images/ad9963.png and down could probably be bumped to 600px width. At some point we should probably re-take all of the schematic screenshots, but let's keep as-is for now.

If we can take care of these things, let's go ahead with this, and make sure to put redirect notes in the corresponding wiki pages.

@gastmaier
Copy link
Copy Markdown
Collaborator

gastmaier commented Mar 3, 2026

Force pushed to resolve conflict triggered by rebase only (merge commit succeeded)

$ git pull public main --rebase

CONFLICT (rename/delete): docs/tools/m2k/windows-eject.png renamed to docs/tools/m2k/images/windows-eject.png in b90973ed0 (m2k: Restructure and add content), but deleted in HEAD.

the solution was to delete, since is not used anywhere (and that is the reason it does not exist in main anymore)

Signed-off-by: Stanca Pop <stanca.pop@analog.com>
@StancaPop StancaPop merged commit 94cc60e into main Apr 27, 2026
5 checks passed
@StancaPop StancaPop deleted the m2k_review branch April 27, 2026 09:06
github-actions Bot added a commit that referenced this pull request Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants